Inside Macintosh: QuickDraw GX Objects /

Chapter 5 - Ink Objects / Ink Objects Reference

Functions / Getting and Setting an Ink's Transfer Mode

GXGetInkTransfer

You can use the GXGetInkTransfer function to examine the transfer mode of an ink object.

gxTransferMode *GXGetInkTransfer(gxInk source, gxTransferMode 
*data);

source

A reference to the ink whose transfer mode you want.

data

A pointer to a transfer mode structure. On return, the structure contains the transfer mode of the ink object.

function result

The transfer mode of the source ink object.

DESCRIPTION

The GXGetInkTransfer function returns, as its function result and in the structure pointed to by the data parameter, the transfer mode of the ink referenced in the source parameter.

If the ink object reference or the pointer to the transfer mode structure is nil, an error is posted, and nil is returned as the function result.

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
ink_is_nil
transferMode_is_nil

SEE ALSO

Transfer modes are described in the sections "About Transfer Modes" beginning on page 5-11, and "Working With Transfer Modes" beginning on page 5-44.

To assign a transfer mode to an ink object, use the GXSetInkTransfer function, described next.

To examine the transfer mode of the ink object associated with a shape, use the GXGetShapeTransfer function, described on page 5-74.